// 版权所有2009 Go作者。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

package runtime

import (
	"runtime/internal/sys"
	"unsafe"
)

type mOS struct{}

// go:noescape 
func futex(addr unsafe.Pointer, op int32, val uint32, ts, addr2 unsafe.Pointer, val3 uint32) int32

// /LinuxFutex。
// 
// futexsleep（uint32*addr，uint32 val）
// futexwakeup（uint32*addr）
// 
// futexsleep以原子方式检查*addr==val，如果是，则睡在addr上。
// Futexwakeup唤醒在addr上睡眠的线程。
// 允许Futexsleep冒充醒来。

const (
	_FUTEX_PRIVATE_FLAG = 128
	_FUTEX_WAIT_PRIVATE = 0 | _FUTEX_PRIVATE_FLAG
	_FUTEX_WAKE_PRIVATE = 1 | _FUTEX_PRIVATE_FLAG
)

// 原子上，
// 如果（*addr==val）睡眠
// 可能会被错误唤醒；那是允许的。
// 睡眠时间不要超过纳秒；ns<0表示永远。
// go:nosplit 
func futexsleep(addr *uint32, val uint32, ns int64) {
	// 一些Linux内核有一个bug，其中futex of 
	// futex_WAIT返回一个内部错误代码
	// 作为错误号。Libpthread忽略返回值
	// 在这里，我们也可以忽略：正如它所说的几行，
	// 允许虚假唤醒。
	if ns < 0 {
		futex(unsafe.Pointer(addr), _FUTEX_WAIT_PRIVATE, val, nil, nil, 0)
		return
	}

	var ts timespec
	ts.setNsec(ns)
	futex(unsafe.Pointer(addr), _FUTEX_WAIT_PRIVATE, val, unsafe.Pointer(&ts), nil, 0)
}

// 如果有任何进程正在addr上睡眠，请最多醒来一次。我不知道futex wakeup是否可以返回EAGAIN或EINTR，但如果它返回，则可以安全地再次循环并调用futex。
func futexwakeup(addr *uint32, cnt uint32) {
	ret := futex(unsafe.Pointer(addr), _FUTEX_WAKE_PRIVATE, cnt, nil, nil, 0)
	if ret >= 0 {
		return
	}

	systemstack(func() {
		print("futexwakeup addr=", addr, " returned ", ret, "\n")
	})

	*(*int32)(unsafe.Pointer(uintptr(0x1006))) = 0x1006
}

func getproccount() int32 {
	// 这个缓冲区很大（8 kB），但我们在系统堆栈上
	// 应该有足够的空间（64 kB）。
	// 这也是一片叶子，所以我们不会把记忆保留太久。
	// 见golang.org/issue/11823。
	// 这里建议的行为是继续尝试使用更大的
	// 缓冲区，但我们在
	// 时刻没有动态内存分配程序，所以这有点棘手，看起来有些过分了。
	const maxCPUs = 64 * 1024
	var buf [maxCPUs / 8]byte
	r := sched_getaffinity(0, unsafe.Sizeof(buf), &buf[0])
	if r < 0 {
		return 1
	}
	n := int32(0)
	for _, v := range buf[:r] {
		for v != 0 {
			n += int32(v & 1)
			v >>= 1
		}
	}
	if n == 0 {
		n = 1
	}
	return n
}

// 克隆，Linux工作。
const (
	_CLONE_VM             = 0x100
	_CLONE_FS             = 0x200
	_CLONE_FILES          = 0x400
	_CLONE_SIGHAND        = 0x800
	_CLONE_PTRACE         = 0x2000
	_CLONE_VFORK          = 0x4000
	_CLONE_PARENT         = 0x8000
	_CLONE_THREAD         = 0x10000
	_CLONE_NEWNS          = 0x20000
	_CLONE_SYSVSEM        = 0x40000
	_CLONE_SETTLS         = 0x80000
	_CLONE_PARENT_SETTID  = 0x100000
	_CLONE_CHILD_CLEARTID = 0x200000
	_CLONE_UNTRACED       = 0x800000
	_CLONE_CHILD_SETTID   = 0x1000000
	_CLONE_STOPPED        = 0x2000000
	_CLONE_NEWUTS         = 0x4000000
	_CLONE_NEWIPC         = 0x8000000

	// 从QEMU 2.8.0（5ea2fc84d）开始，用户仿真要求在创建线程时设置所有六个
	// 标志；尝试共享另一个
	// 5，但不共享SYSVSEM将失败，返回-EINVAL。
	// 
	// 在非QEMU环境中，克隆系统是无关紧要的，因为我们不使用System V信号量。

	cloneFlags = _CLONE_VM | /* share memory */
		_CLONE_FS | /* share cwd, etc */
		_CLONE_FILES | /* share fd table */
		_CLONE_SIGHAND | /* share sig handler table */
		_CLONE_SYSVSEM | /* share SysV semaphore undo lists (see issue #20763) */
		_CLONE_THREAD /* revisit - okay for now */
)

// go:noescape 
func clone(flags int32, stk, mp, gp, fn unsafe.Pointer) int32

// 可能在m.p==nil的情况下运行，因此不允许使用写屏障。
// go:nowritebarrier 
func newosproc(mp *m) {
	stk := unsafe.Pointer(mp.g0.stack.hi)
	/*
	 * note: strace gets confused if we use CLONE_PTRACE here.
	 */
	if false {
		print("newosproc stk=", stk, " m=", mp, " g=", mp.g0, " clone=", funcPC(clone), " id=", mp.id, " ostk=", &mp, "\n")
	}

	// 在克隆过程中禁用信号，以便新线程在禁用信号的情况下启动
	// 。它将在minit中启用它们。
	var oset sigset
	sigprocmask(_SIG_SETMASK, &sigset_all, &oset)
	ret := clone(cloneFlags, stk, unsafe.Pointer(mp), unsafe.Pointer(mp.g0), unsafe.Pointer(funcPC(mstart)))
	sigprocmask(_SIG_SETMASK, &oset, nil)

	if ret < 0 {
		print("runtime: failed to create new OS thread (have ", mcount(), " already; errno=", -ret, ")\n")
		if ret == -_EAGAIN {
			println("runtime: may need to increase max user processes (ulimit -u)")
		}
		throw("newosproc")
	}
}

// 不需要有效G的newosproc版本。
// go:nosplit 
func newosproc0(stacksize uintptr, fn unsafe.Pointer) {
	stack := sysAlloc(stacksize, &memstats.stacks_sys)
	if stack == nil {
		write(2, unsafe.Pointer(&failallocatestack[0]), int32(len(failallocatestack)))
		exit(1)
	}
	ret := clone(cloneFlags, unsafe.Pointer(uintptr(stack)+stacksize), nil, nil, fn)
	if ret < 0 {
		write(2, unsafe.Pointer(&failthreadcreate[0]), int32(len(failthreadcreate)))
		exit(1)
	}
}

var failallocatestack = []byte("runtime: failed to allocate stack for the new OS thread\n")
var failthreadcreate = []byte("runtime: failed to create new OS thread\n")

const (
	_AT_NULL   = 0  // 向量结束
	_AT_PAGESZ = 6  // 系统物理页面大小
	_AT_HWCAP  = 16 // 硬件能力位向量
	_AT_RANDOM = 25 // 在2.6.29 
	_AT_HWCAP2 = 26 // 硬件能力位向量2 
)

var procAuxv = []byte("/proc/self/auxv\x00")

var addrspace_vec [1]byte

func mincore(addr unsafe.Pointer, n uintptr, dst *byte) int32

func sysargs(argc int32, argv **byte) {
	n := argc + 1

	// 跳过argv，envp以访问auxv 
	for argv_index(argv, n) != nil {
		n++
	}

	// 跳过空分隔符
	n++

	// 现在argv+n是auxv 
	auxv := (*[1 << 28]uintptr)(add(unsafe.Pointer(argv), uintptr(n)*sys.PtrSize))
	if sysauxv(auxv[:]) != 0 {
		return
	}
	// 在某些情况下，我们无法获得
	// auxv提供的加载程序，例如在Android上作为库加载时。
	// 返回到/proc/self/auxv。
	fd := open(&procAuxv[0], 0 /* O_RDONLY */, 0)
	if fd < 0 {
		// 在Android上，/proc/self/auxv可能无法读取（第9229期），因此我们退回到
		// 尝试使用mincore检测物理页面大小。
		// 当地址不是系统页面大小的倍数时，mincore应返回EINVAL。
		const size = 256 << 10 // 要分配的内存区域大小
		p, err := mmap(nil, size, _PROT_READ|_PROT_WRITE, _MAP_ANON|_MAP_PRIVATE, -1, 0)
		if err != 0 {
			return
		}
		var n uintptr
		for n = 4 << 10; n < size; n <<= 1 {
			err := mincore(unsafe.Pointer(uintptr(p)+n), 1, &addrspace_vec[0])
			if err == 0 {
				physPageSize = n
				break
			}
		}
		if physPageSize == 0 {
			physPageSize = size
		}
		munmap(p, size)
		return
	}
	var buf [128]uintptr
	n = read(fd, noescape(unsafe.Pointer(&buf[0])), int32(unsafe.Sizeof(buf)))
	closefd(fd)
	if n < 0 {
		return
	}
	// 确保buf已终止，即使我们没有读取整个文件。
	buf[len(buf)-2] = _AT_NULL
	sysauxv(buf[:])
}

// startupRandomData保存启动时初始化的随机字节。这些来自
// ELF AT_随机辅助向量。
var startupRandomData []byte

func sysauxv(auxv []uintptr) int {
	var i int
	for ; auxv[i] != _AT_NULL; i += 2 {
		tag, val := auxv[i], auxv[i+1]
		switch tag {
		case _AT_RANDOM:
			// 内核提供了一个指向16字节的随机数据的指针。
			startupRandomData = (*[16]byte)(unsafe.Pointer(val))[:]

		case _AT_PAGESZ:
			physPageSize = val
		}

		archauxv(tag, val)
		vdsoauxv(tag, val)
	}
	return i / 2
}

var sysTHPSizePath = []byte("/sys/kernel/mm/transparent_hugepage/hpage_pmd_size\x00")

func getHugePageSize() uintptr {
	var numbuf [20]byte
	fd := open(&sysTHPSizePath[0], 0 /* O_RDONLY */, 0)
	if fd < 0 {
		return 0
	}
	ptr := noescape(unsafe.Pointer(&numbuf[0]))
	n := read(fd, ptr, int32(len(numbuf)))
	closefd(fd)
	if n <= 0 {
		return 0
	}
	n-- // 删除尾随新行
	v, ok := atoi(slicebytetostringtmp((*byte)(ptr), int(n)))
	if !ok || v < 0 {
		v = 0
	}
	if v&(v-1) != 0 {
		// v不是2的幂
		return 0
	}
	return uintptr(v)
}

func osinit() {
	ncpu = getproccount()
	physHugePageSize = getHugePageSize()
	if iscgo {
		// /42494Glibc和musl保留一些信号供
		// 内部使用，并要求它们不被
		// 正常C运行时的其余部分阻塞。当go运行时
		// 阻塞…解除阻塞信号时，暂时阻塞的
		// 时间间隔通常很短。因此，
		// 这些对*libc代码的期望主要由
		// 组合的go+cgo线程系统来满足。但是，当go导致线程退出时，通过从
		// mstart（）返回，如果
		// 这些信号被阻止，组合运行时可能会死锁。因此，退出线程时不要阻止这些
		// 信号。
		// /-glibc:SIGCANCEL（32）、SIGSETXID（33）
		// /-musl:SIGTIMER（32）、SIGCANCEL（33）、SIGSYNCCALL（34）
		sigdelset(&sigsetAllExiting, 32)
		sigdelset(&sigsetAllExiting, 33)
		sigdelset(&sigsetAllExiting, 34)
	}
	osArchInit()
}

var urandom_dev = []byte("/dev/urandom\x00")

func getRandomData(r []byte) {
	if startupRandomData != nil {
		n := copy(r, startupRandomData)
		extendRandom(r, n)
		return
	}
	fd := open(&urandom_dev[0], 0 /* O_RDONLY */, 0)
	n := read(fd, unsafe.Pointer(&r[0]), int32(len(r)))
	closefd(fd)
	extendRandom(r, int(n))
}

func goenvs() {
	goenvs_unix()
}

// 调用以同步初始化使用
// /-buildmode=c-archive或-buildmode=c-shared构建的Go代码。
// Go运行时均未初始化。
// go:nosplit 
// go:nowritebarrierrec 
func libpreinit() {
	initsig(true)
}

// 调用以初始化新的m（包括引导程序m）。
// 在父线程（引导时为主线程）上调用，可以分配内存。
func mpreinit(mp *m) {
	mp.gsignal = malg(32 * 1024) // Linux希望>=2K 
	mp.gsignal.m = mp
}

func gettid() uint32

// 调用以初始化新的m（包括引导程序m）。
// 在新线程上调用，无法分配内存。
func minit() {
	minitSignals()

	// Cgo创建的线程和引导程序m缺少
	// procid。我们需要这个用于异步抢占，它在调试器中非常有用。
	getg().m.procid = uint64(gettid())
}

// 从drop调用以撤消minit的效果。
// go:nosplit 
func unminit() {
	unminitSignals()
}

// 从exitm调用，而不是从drop调用，以撤消线程拥有的
// minit、semacreate或其他资源的效果。调用此命令后不要使用锁。
func mdestroy(mp *m) {
}

// /#ifdef GOARCHU 386 
// /#定义SAU处理程序k#SAU处理程序
// /#endif 

func sigreturn()
func sigtramp() // 通过ABI 
func cgoSigtramp()

// 调用go noescape 
func sigaltstack(new, old *stackt)

// go noescape 
func setitimer(mode int32, new, old *itimerval)

// go go noescape 
func rtsigprocmask(how int32, new, old *sigset, size int32)

// go NOEPLIT 
func sigprocmask(how int32, new, old *sigset) {
	rtsigprocmask(how, new, old, int32(unsafe.Sizeof(*new)))
}

func raise(sig uint32)
func raiseproc(sig uint32)

func sched_getaffinity(pid, len uintptr, buf *byte) int32
func osyield()

// go:nosplit 
func osyield_no_g() {
	osyield()
}

func pipe() (r, w int32, errno int32)
func pipe2(flags int32) (r, w int32, errno int32)
func setNonblock(fd int32)

// go:nosplit 
// go:nowritebarrierrec 
func setsig(i uint32, fn uintptr) {
	var sa sigactiont
	sa.sa_flags = _SA_SIGINFO | _SA_ONSTACK | _SA_RESTORER | _SA_RESTART
	sigfillset(&sa.sa_mask)
	// 虽然Linux手册页上说“sau restorer元素已过时，不应使用
	// ”。x86_64内核需要它。只能在
	// x86上使用。
	if GOARCH == "386" || GOARCH == "amd64" {
		sa.sa_restorer = funcPC(sigreturn)
	}
	if fn == funcPC(sighandler) {
		if iscgo {
			fn = funcPC(cgoSigtramp)
		} else {
			fn = funcPC(sigtramp)
		}
	}
	sa.sa_handler = fn
	sigaction(i, &sa, nil)
}

// go:nosplit 
// go:NOWRITEBRIERREC 
func setsigstack(i uint32) {
	var sa sigactiont
	sigaction(i, nil, &sa)
	if sa.sa_flags&_SA_ONSTACK != 0 {
		return
	}
	sa.sa_flags |= _SA_ONSTACK
	sigaction(i, &sa, nil)
}

// go:nosplit 
// go:NOWRITEBRIERREC 
func getsig(i uint32) uintptr {
	var sa sigactiont
	sigaction(i, nil, &sa)
	return sa.sa_handler
}

// setSignaltstackSP设置堆栈的ss_sp字段。
// go:nosplit 
func setSignalstackSP(s *stackt, sp uintptr) {
	*(*uintptr)(unsafe.Pointer(&s.ss_sp)) = sp
}

// go:nosplit 
func (c *sigctxt) fixsigcode(sig uint32) {
}

// sysSigaction调用rt\u sigaction系统调用。
// go:nosplit 
func sysSigaction(sig uint32, new, old *sigactiont) {
	if rt_sigaction(uintptr(sig), new, old, unsafe.Sizeof(sigactiont{}.sa_mask)) != 0 {
		// QEMU用户模式模拟中的错误解决方法。
		// 
		// QEMU将对sigaction系统调用的调用转换为对C库sigaction调用的调用；C 
		// 库调用拒绝为
		// SIGCANCEL（32）或SIGSETXID（33）调用sigaction的尝试。
		// 
		// QEMU拒绝在SIGRTMAX（64）上调用sigaction。
		// 
		// 在这种情况下忽略错误。无论如何，我们对此无能为力。
		if sig != 32 && sig != 33 && sig != 64 {
			// 使用系统堆栈避免ppc64/ppc64le上的拆分堆栈溢出。
			systemstack(func() {
				throw("sigaction failed")
			})
		}
	}
}

// rt_sigaction在汇编中实现。
// go:noescape 
func rt_sigaction(sig uintptr, new, old *sigactiont, size uintptr) int32

func getpid() int
func tgkill(tgid, tid, sig int)

// signalM向mp发送信号。
func signalM(mp *m, sig int) {
	tgkill(getpid(), int(mp.procid), sig)
}
